Associating web service API users with internal roles

Associate web service API users with Internal Roles on the Shared Web Server panel in Runtime Management.

Before you begin

You must have the Runtime Management privilege to perform this task. If you have the Runtime Management Read Access privilege, you cannot perform the task.

Before you begin, create one or more internal roles on the Internal Roles page of (Authentication > Internal).

About this task

By associating a group of users to a single internal role, you can grant API access to all the users associated with that internal role for specific web service components at once without needing to set the permissions individually.

Procedure

1. Navigate to Manage > Runtime Management.

2. Select the appropriate runtime and click Shared Web Server.

   The Shared Web Server panel is displayed.

3. On the General tab, set the API Type to Advanced.

4. On the User Management tab, click the Enable Internal Roles check box.

   An Internal Roles Management tab is added to the panel.

5. Click Add Internal Role.

   The Add Internal Role dialog opens.

6. Select the Internal Role from the drop-down list.

7. Click OK.

8. Add one or more users from the Add Role to User drop-down list.

9. Click Save.

Next steps

After associating API users with internal roles, update the API to only allow access to a specific internal role.